home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1996 February
/
EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso
/
earcd
/
util1
/
syslog.lha
/
SysLog_V1.00
/
Developer
/
SysLog.autodoc
Wrap
Text File
|
1995-11-13
|
4KB
|
137 lines
TABLE OF CONTENTS
syslog.library/--background--
syslog.library/Log
syslog.library/DeleteSysLogMessage
syslog.library/GetSysLogMsgTime
syslog.library/AddSysLogSpy
syslog.library/RemSysLogSpy
syslog.library/Log syslog.library/Log
NAME
Log - Log a message
SYNOPSIS
Log( pri, options, tag, message, argarray )
D0 D1 A0 A1 A2
void Log( LONG pri, LONG options, UBYTE *tag, UBYTE *message, LONG *argarray );
FUNCTION
This routine sends a message to all spies connected to syslog.library.
The message is constructed from tag, message and arguments. This
routine is safe to be called from interrupts as long as LOG_PID,
LOG_PERROR and LOG_CONS options are not used. LOG_PERROR and LOG_CONS
options can not be used when this routine is called by a task.
If LOG_PID option is used, the current task's process number, or if
Executive is present, task's PID is included in the message.
LOG_PERROR and LOG_CONS output the message to current error stream
and to current console. If processes's pr_CES is NULL, pr_COS is
used.
Maximum length including time is 1024 characters.
INPUTS
pri - facility and priority
options - miscellaneous options
tag - tag the message with this string
message - message to log
argarray - pointer to array of arguments
SEE ALSO
<libraries/syslog.h>
syslog.library/DeleteSysLogMessage syslog.library/DeleteSysLogMessage
NAME
DeleteSysLogMessage - Delete a message generated by syslog.library
SYNOPSIS
DeleteSysLogMessage( message )
A0
void DeleteSysLogMessage( struct SysLogMessage *message );
FUNCTION
When a SPY has processed a message it has received from syslog.library,
it must call this routine. The message is deleted and memory deallocated.
INPUTS
message - message received from syslog.library
SEE ALSO
<libraries/syslog.h>, AddSysLogSpy(), RemSysLogSpy()
syslog.library/GetSysLogMsgTime syslog.library/GetSysLogMsgTime
NAME
GetSysLogMsgTime - Put a time stamp to SysLog message
SYNOPSIS
GetSysLogMsgTime( message )
A0
void GetSysLogMsgTime( struct SysLogMessage *message );
FUNCTION
When a message is received from syslog.library, this routine must
be called. A time stamp will be written to the message. There are
some good reasons why Log()-function can't easily/quickly obtain
the current system time, especially if it's called from interrupt.
Even if you would call this function long time after the message
was generated, the time will still be correct.
INPUTS
message - message received from syslog.library
SEE ALSO
<libraries/syslog.h>, AddSysLogSpy(), RemSysLogSpy()
syslog.library/AddSysLogSpy syslog.library/AddSysLogSpy
NAME
AddSysLogSpy - Add a spy to syslog.library
SYNOPSIS
SysLogSpy = AddSysLogSpy()
D0
struct SysLogSpy *AddSysLogSpy( void );
FUNCTION
If you want to listen to log messages, you can add a spy to
syslog.library. This routine returns an initialized SysLogSpy
structure. Messages will be sent to Spy_port, found in the
returned structure.
When this function returns, there may already be a message in
the Spy_port.
INPUTS
None
RESULT
Initialized SysLogSpy structure, NULL if error
SEE ALSO
<libraries/syslog.h>, RemSysLogSpy(), DeleteSysLogMessage(), GetSysLogMsgTime()
syslog.library/RemSysLogSpy syslog.library/RemSysLogSpy
NAME
RemSysLogSpy - Remove a spy from syslog.library
SYNOPSIS
RemSysLogSpy( spy )
RemSysLogSpy( struct SysLogSpy * );
A0
FUNCTION
A spy added using AddSysLogSpy() must be removed with this
function. Messages still in the Spy_port will be safely deallocated.
INPUTS
spy - SysLogSpy structure returned by AddSysLogSpy()
SEE ALSO
<libraries/syslog.h>, AddSysLogSpy(), DeleteSysLogMessage(), GetSysLogMsgTime()